home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_100 / 129_02 / util.doc < prev    next >
Encoding:
Text File  |  1985-03-09  |  11.3 KB  |  232 lines
  1. /************************************************************************/
  2. /*                Util.doc                */
  3. /************************************************************************/
  4.  
  5. /************************************************************************/
  6. /*                History                 */
  7. /*                                    */
  8. /*  84Dec09  HAW Expand changed.                    */
  9. /*  84Jun29  HAW Ctdlchng detailed.                    */
  10. /*  84Jun28  HAW Expand detailed.                    */
  11. /*  84Jun27  HAW Recover1 detailed.                    */
  12. /*  84Jun26  HAW Clray detailed.                    */
  13. /*  84Jun26  HAW Created. Clog detailed.                */
  14. /************************************************************************/
  15.  
  16. /************************************************************************/
  17. /*                Audience                */
  18. /*                                    */
  19. /*  Sysop and other troll-like folk.                    */
  20. /************************************************************************/
  21.  
  22. /************************************************************************/
  23. /*                Purpose                 */
  24. /*                                    */
  25. /*  Let the poor unfortunates be even more confused over what's     */
  26. /*  available.                                */
  27. /************************************************************************/
  28.  
  29. /************************************************************************/
  30. /*                Contents                */
  31. /*                                    */
  32. /*    Introduction        Intro to this doc.            */
  33. /*    Clog.com        Description of Clog.            */
  34. /*    Clray.com        Description of Clray.            */
  35. /*    Recover1.com        Description of Recover1.        */
  36. /*    Expand.com        Description of Expand.            */
  37. /*    Ctdlchng.com        Description of Ctdlchng.        */
  38. /************************************************************************/
  39.  
  40. /************************************************************************/
  41. /*                Introduction                */
  42. /************************************************************************/
  43.  
  44.    Since the days of yore when we received Citadel from CUG (C User's Group),
  45. several utilities of interest have been added to the package to supplement
  46. the original two .com files that came with the package, to wit CITADEL.COM
  47. and CONFIGUR.COM.  These come in two types: one, to provide information about
  48. what's going on inside this monster which, due to runtime space considerations,
  49. could not be gotten at; two, the ability to change certain parameters which were
  50. either impossible to change once a BBS was set up, or were, at the least,
  51. difficult to change.
  52.    The descriptions (such as they are) follow herein!
  53.  
  54. /************************************************************************/
  55. /*                Clog.com                */
  56. /************************************************************************/
  57.  
  58.    Clog provides access to the userlog for the Sysop.  To use it, the file
  59. CTDLTABL.SYS (the one generated by CONFIGUR and maintained by CITADEL.COM)
  60. must be on the default disk, and so must be CTDLLOG.SYS.
  61.  
  62.    There are two ways of using Clog.  First, there is the simple call:
  63.  
  64.     D>CLOG
  65.  
  66. This will print out on the console the list of users in the file as they
  67. appear in the file.  The user of this program should be warned that Citadel
  68. does not put new users into the userlog in sequential order.  Instead, they
  69. are hashed into the log.  Usually, first user to log into the system ends
  70. up occupying the last position in the file!  In general, users are sprinkled
  71. everywhere, so don't be alarmed if nothing shows up right away.  Be patient.
  72.  
  73.    In any case, the list is printed out as follows.  First, the log position
  74. will be printed out, which will always be in sequential order.    If nobody
  75. occupies that position, then Clog proceeds to the next log position.  If
  76. somebody does occupy that position, then the name of that person (or alias)
  77. will be printed out, followed by his/her status as aide, expert/non-expert, and
  78. screen width.
  79.  
  80.    The second way to use Clog is to give it arguments.    There are two arguments
  81. currently available.  The first is "-D", as in
  82.  
  83.       D>CLOG -D
  84.  
  85.    The -D argument will cause a file to be made concurrently with the printout
  86. on the screen; the printout will be a identical image of what you see on the
  87. screen.  The file's name will be CTDLLOG.LST, and will automatically wipe out
  88. any other files of the same name on disk.  Incidentally, the file is written
  89. to the default disk, not the HOMEDISK.
  90.  
  91.    The second argument is "-P".  This will cause the passwords to be listed
  92. along with the user's name.  This is useful if somebody forgets their password.
  93.  
  94.    The two arguments may both be present, in either order.  Illegal arguments
  95. will be ignored.
  96.  
  97. /************************************************************************/
  98. /*                Clray.com                */
  99. /************************************************************************/
  100.  
  101.    Clray.com is another program used to view the userlog.  As before,
  102. CTDLTABL.SYS must be on the default disk in the default user area, as must
  103. CTDLLOG.SYS.  There are currently no arguments for Clray.
  104.  
  105.    Clray's purpose is to allow the sysop to see what order the users have been
  106. calling in, starting with the last caller.  Along with the users name, his/her
  107. aide status, column width, and expert status will be printed, as in Clog.
  108.  
  109.    Simply call Clray to run it.
  110.  
  111. /************************************************************************/
  112. /*                Recover1.com                */
  113. /************************************************************************/
  114.  
  115.    Occassionally, a room may be killed by accident by an aide.    Or worse, a
  116. Village Idiot will break an aide's password, and then kill rooms which the
  117. Sysop thinks has socially redeeming value.  It is at this point that Recover1
  118. may be of use.
  119.  
  120.    Recover1 may only be used if the following applies -- rooms have been killed,
  121. but no rooms have been created.  If a room(s) has been created, it may have
  122. overwritten the old data. Rooms which weren't overwritten can still be saved of
  123. course.  If new rooms have been created, Recover2.com should be used. If
  124. Recover2.com is not detailed in this doc, then it doesn't exist and don't go
  125. looking frantically for it.
  126.  
  127.    To use Recover1, CTDLTABL.SYS must be on the default disk and user area.
  128. CTDLROOM.SYS must be on HOMEDISK and HOMEUSER.    Simply call Recover1.  It
  129. will read in CTDLTABL.SYS.  Then it will start looking at the rooms as found
  130. in CTDLTABL.SYS.  When it finds evidence that a room has been killed, it
  131. will printout on the screen the name of the room, and ask the Sysop if s/he
  132. wants Recover1 to try to save the room.  If it receives an upper or lower
  133. case Y, then it will do so.  Currently, there is no reason known why it
  134. shouldn't succeed.
  135.  
  136.    When finished it will announce so and replace CTDLTABL.SYS with the
  137. updated version, and then leave.  However, hopefully you'll never need this
  138. program.
  139.  
  140. /************************************************************************/
  141. /*                Expand.com                */
  142. /************************************************************************/
  143.  
  144.    Expand's purpose in life is to allow the sysop to expand the size of his/her
  145. message file (CTDLMSG.SYS).  This makes it easy to move upwards as one gets rich
  146. running Citadel for cold, hard cash and acquires better and better equipment.
  147.  
  148.    Expand expects to find the file CTDLTABL.SYS on the default disk in the
  149. default user area and the CTDLMSG.SYS file on MSGDISK.    Simply call Expand
  150. without arguments.  Once it has loaded CTDLTABL.SYS, it will display the
  151. current size of the message file, and then ask
  152. for the new size.  Answer in Kbytes, in decimal (unlike CTDLCNFG.SYS --
  153. remember when changing CTDLCNFG.SYS to accomodate the new message size to
  154. change the number back to hex).  Now Expand will do it's job.  THIS IS A
  155. SLOW PROCESS.  Be patient.  The program will be printing some stuff out
  156. that might allow the sysop to figure out where the program is.
  157.  
  158.    Once the program is done, it will say so, and will also tell you that
  159. there is no reason to reconfigure.  This is true.
  160.  
  161.    IF you are changing the value of MSGDISK, which would usually merit a
  162. reconfigure (groan), please see the section of this doc covering the
  163. program called Ctdlchng.com.  This should be of help to you.
  164.  
  165. /************************************************************************/
  166. /*                Ctdlchng.com                */
  167. /************************************************************************/
  168.  
  169.    The purpose of Ctdlchng.com is to allow the sysop to change certain of
  170. the parameters present in CTDLCNFG.SYS to a different value without going
  171. thru the entire reconfiguration process one more time.    Ctdlchng expects to
  172. find CTDLTABL.SYS on the default disk and user area.
  173.  
  174.    To use this program, ctdlchng may be called with 0 or more arguments.  If
  175. it is called with 0 arguments, the program prints on the sysop's console an
  176. explanation of Ctdlchng's purpose and it's argument usage and returns the
  177. sysop to CP/M.    If 1 or more arguments are present, then each argument is
  178. processed.  Each argument on the command line should be separated by a space.
  179.  
  180.    The user of this program will note that in the following list of supported
  181. arguments, all derive straight from CTDLCNFG.SYS parameters.
  182.  
  183.    There are two types of arguments possible, one to change a "boolean" value,
  184. and one to change a "numerical" value.
  185.  
  186.    To change a boolean value, merely type its name as an argument to Ctdlchng.
  187. The value of that boolean will then be "flipped" to its opposite value.  The
  188. list of boolean arguments supported is as follows:
  189.  
  190. ROOMOK          -- Is it ok for ordinary folk to create rooms?
  191. ENTEROK       -- Is it ok for unlogged folk to enter messages?
  192. READOK          -- Is it ok for unlogged folk to read messages?
  193. LOGINOK       -- Can unlogged people make their own logins? (Is system private?)
  194. RCPM          -- Is system RCP/M? (Huh?)
  195. CLOCK          -- Does system have a clock?
  196. ALLMAIL       -- Can everybody send mail, or only aides?
  197.  
  198.    So, if the sysop had originally configured with ALLMAIL set to 0, i.e., s/he
  199. didn't want ordinary users to have access to the mail, and now has decided to
  200. allow all access to the mail, the sysop would type
  201.  
  202.    A>d:ctdlchng allmail
  203.  
  204. and the value would be flipped.  More than one of the above could be entered on
  205. the command line.
  206.  
  207.    To change a numerical value, the sysop types the name of the numerical
  208. variable, followed immediately by an '=x', where x is an integer.  NOTE THAT
  209. X MUST BE A DECIMAL NUMBER, UNLIKE THE CTDLCNFG.SYS FILE!!!!  Also note that
  210. when changing CTDLCNFG.SYS, remember to convert back to hex.  Yah, it's a pain
  211. in the neck.  The reason CTDLCNFG.SYS must be changed is that the next time
  212. Citadel crashes (whether it be a software or hardware crash), you don't want
  213. to reconfigure with the old values still present.  ALSO, THERE CAN BE NO SPACES
  214. BETWEEN THE VARIABLE NAME, THE EQUAL SIGN, AND THE INTEGER, OR CTDLCHNG.SYS
  215. WILL BE HORRIBLY, HORRIBLY CONFUSED.  The list of supported numerical values
  216. is as follows:
  217.  
  218. MSGDISK       -- Disk the message disk is on (A:=0, B:=1, ...).
  219. HOMEUSER      -- User area where all other support and data files are kept.
  220. HOMEDISK      -- Disk where all other support and data files are kept.
  221. MEGAHZ          -- CPU speed.  For timing loops.
  222. MDATA          -- Modem data port.
  223.  
  224.    So, to change the megahertz your computer is running at, type
  225.  
  226.    A>d:ctdlchng MEGAHZ=4
  227.  
  228.    or whatever the new speed of the machine is.
  229.  
  230.    Numerical and boolean variable changes may be mixed as the sysop pleases.
  231. o note that
  232. when changing CTDLCNFG.SYS, remember to convert back to hex.  Yah, i